home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 51 / Amiga Format CD51 (2000-03-10)(Future Publishing)(GB)[!][issue 2000-04].iso / -in_the_mag- / pdselect / awnp / awnp-docs / listbrowser.doc < prev    next >
Text File  |  2000-02-16  |  5KB  |  168 lines
  1. ListBrowser gadget event
  2. -------------------------
  3.  
  4. 'gadget GID event_source event_column NodeGID [NodeGID [NodeGID ...]]'
  5.  
  6. event_source&1 means normal selection of node.
  7.  
  8. event_source&2 means this nodes children have been hidden.
  9.  
  10. event_source&4 means this nodes children are now shown.
  11.  
  12. event_source&8 means node has been edited.
  13.  
  14. event_source&16 means double click on node.
  15.  
  16. event_column is the column the mouse was over when the node was clicked.
  17.  
  18. ListBrowser gadget parameters.
  19. -------------------------
  20.  
  21. font=GID
  22.  
  23. This sets the font for the gadget. The GID points to an ALREADY defined text attribute.
  24.  
  25. readonly (ro)
  26.  
  27.  This list browser entries can not be edited.
  28.  
  29. disable=number (dis=)
  30.  
  31.  The gadget is disabled if number = 0 , enabled if number != 0. Defaults to enabled.
  32.  
  33. selected=number (s=)
  34.  
  35.   Set which choice is selected when the window opens. Selections start at 0 . This defaults to none. CAREFUL modify uses the listnode GID, this parameter uses the ordinal position of the node.
  36.  
  37. ListbrowserLabels="text0|text1|text..."  (lbl=)
  38.  
  39.  Set the column labels for the list. Defaults to 1 unlabeled column.  NO MORE THAN 20 COLUMNS can be defined !
  40.  
  41. bnparent (bnp)
  42.  
  43.  Allow parenting in this listbrowser.
  44.  
  45. showtitles (st)
  46.  
  47.  Show the column tiles of this listbrowser.
  48.  
  49. vertical (v)
  50.  
  51.  Use veticle seperators in the listbrowser.
  52.  
  53. hori (h)
  54.  
  55.  Use horizontal seperators in the listbrowser.
  56.  
  57. arrows   (a)
  58.  
  59.  Show arrows for horizontal scrolling and make this a virtual width list.
  60.  
  61. multi  (m)
  62.  
  63.  Switch to allow multi selection in the list. Multi select by holding the shift key.
  64.  
  65. minwidth=number (minw=)
  66.  
  67.  Set the minimum width for this gadget
  68.  
  69. minheight=number (minh=)
  70.  
  71.  Set the minimum height for this gadget
  72.  
  73. weightedwidth=number (weiw=)
  74.  
  75.  Set the weighted width for this gadget
  76.  
  77. weightedheight=number (weih=)
  78.  
  79.  Set the weighted height for this gadget
  80.  
  81. nominalsize (noms)
  82.  
  83.  Set this gadget to its nominal size.
  84.  
  85. SPECIAL FUNCTION
  86. -----------------
  87.  
  88.  Using sort on a line BY ITSELF durring gadget definitions will cause the last defined listbrowser to be sorted. This is to allow a list browser to be sorted before the gui window is opened. (the modify sort comand sorts the listbrowser after the window is opened.)
  89.  
  90. sort=COLUMN#
  91.  
  92.  Sort list browser based on the column number. Remember columns start at 0. You MUST NOT specify an invalid column number.
  93.  
  94.  
  95. Definition Reply
  96. -----------------
  97.  
  98.  When the gadget creation is successful the pipe replies with
  99.  
  100. 'ok GID'
  101.  
  102. ListBrowser gadget modify parameters.
  103. -------------------------
  104. down
  105.  
  106. Select the next node in the list.
  107.  
  108. up
  109.  
  110. Select the previous node in the list.
  111.  
  112. addnode (addn)
  113.  
  114.  Add a new node to this ListBrowser
  115.  
  116. GadgetText="[^|¶]text0|[^|¶]text1|[^|¶]text..." (gt=)
  117.  
  118.  Set the text(s) for the added node. This parameter MUST be given. YOU MUST NOT GIVE MORE TEXTS THAN THE AMOUNT OF COLUMNS IN THE LISTBROWSER. A leading '^' makes the text editable. A leading '¶' (ALT p) uses the last defined image for the column rather than text. Note that images used in browsernodes can not be more than 255 pixels high. (hint: split larger images and use more than one node)
  119.  
  120. defnumber=number  (defn=)
  121.  
  122.  Set the Generation of this browser node.
  123.  
  124. target=GID  (tar=)
  125.  
  126.  If GID=0 add the new node at head of list. If GID=-1 add the new node at tail of list. Else add the new node immediately after the node specified by GID.
  127.  
  128. browsernodeparent  (bnp)
  129.  
  130.  The new browser node has children.
  131.  
  132. List=number
  133.  
  134.  If number=0 detach the node list from the listbrowser. If number!=0 then reattaches the node list to the listbrowser.
  135.  
  136. removenode (remn)
  137.  
  138.  Remove ALL browsernodes from this ListBrowser.
  139.  
  140. readonly (ro)
  141.  
  142.  This list browser entries can not be edited.
  143.  
  144. disable=number (dis=)
  145.  
  146.  The gadget is disabled if number = 0 , enabled if number != 0.
  147.  
  148. scroll=GID (scr=)
  149.  
  150.  Scroll the listbrowser so the node specified by GID is at the top.
  151.  
  152. selected=GID (s=)
  153.  
  154.   For multi select lists
  155.  
  156.  You may set the nodes individually instead of using this command. Sets which choice is selected . Setting selected=0 sets all nodes as unselected. Setting selected=-1 sets all nodes as selected. CAREFUL modify uses the listnode GID.
  157.  
  158.   For single select lists
  159.  
  160.  Set the selected node. Selected=0 sets all nodes as unselected. CAREFUL modify uses the listnode GID not the ordinal position. This is different then in the listbrowser definition.
  161.  
  162. sort=COLUMN#
  163.  
  164.  Sort this list browser based on the column number. Remember columns start at 0. You MUST NOT specify an invalid column number.
  165.  
  166. autofit
  167.  
  168.  This keyword forces the listbrowser to revaluate its size. It is only needed when a listbrowser uses a font other than the screen default font AND no new browser nodes are added after the GUI window is opened.